Removing create_span from the api #290

codeboten · 2019-11-14T19:15:41Z

Simplifying the API by removing create_span. Updated the WSGI integration and docs.

Resolves #152

Signed-off-by: Alex Boten [email protected]

Signed-off-by: Alex Boten <[email protected]>

codecov-io · 2019-11-14T19:33:35Z

Codecov Report

Merging #290 into master will decrease coverage by 0.11%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #290      +/-   ##
==========================================
- Coverage   85.66%   85.55%   -0.12%     
==========================================
  Files          33       33              
  Lines        1612     1599      -13     
  Branches      180      178       -2     
==========================================
- Hits         1381     1368      -13     
  Misses        185      185              
  Partials       46       46

Impacted Files	Coverage Δ
...ntelemetry-api/src/opentelemetry/trace/__init__.py	`85.95% <ø> (-0.34%)`	⬇️
...emetry-sdk/src/opentelemetry/sdk/trace/__init__.py	`88.94% <100%> (-0.18%)`	⬇️
...ry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py	`90.54% <100%> (-0.37%)`	⬇️
...src/opentelemetry/ext/opentracing_shim/__init__.py	`95.83% <100%> (-0.14%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update da8b8d9...371fa89. Read the comment docs.

Oberon00 · 2019-11-15T16:44:22Z

From #206 (comment):

This PR must not remove the capability of specifying explicit start times for the span. This is both in the spec and was explicitly requested, see #134. I guess the parameter should be added to start_span at least.

Oberon00 · 2019-11-15T16:46:35Z

opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py

+        Applications that need to create spans detached from the tracer's
+        context should use this method.


I would remove this paragraph, and maybe also rename the method to _create_span. Or we could commit to having this method be a "semi-public" interface of the SDK, to be overriden by any vendor-SDKs that need their own Span type but nevertheless want to reuse functionality from vendor SDKs.

In any case, applications (or any instrumentation use case really) must not use this method.

Oberon00 · 2019-11-15T16:49:56Z

We should also remove span.start() from the public API. We can either move the code to Tracer.start_span or just remove the method from the API but keep it in the SDK (preferably renaming it to _start).

This preserves the ability to set the `start_time` of a span that is currently available through calling `.start` Signed-off-by: Alex Boten <[email protected]>

Signed-off-by: Alex Boten <[email protected]>

codeboten · 2019-11-19T18:49:47Z

opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py

-        return trace_api.DefaultSpan(context=context)
+            span.start(start_time=start_time)
+        else:
+            span = trace_api.DefaultSpan(context=context)


Would love some feedback on whether or not this is the right thing to do here, since a DefaultSpan no longer has a start() method, I'm just returning it after creation

I think this is fine, a DefaultSpan doesn't even know whether it was started anyway.

Oberon00 · 2019-11-22T12:51:45Z

@open-telemetry/python-approvers: We need more reviews for this one!

c24t

Changes LGTM, FYI I pushed some conflict fixes after merging #206.

c24t · 2019-11-23T01:35:54Z

In 371fa89 I changed some tests that relied on the fact that start_span and others called create_span and start under the hood. These changes make the tests more brittle since they're checking for a specific call now (start_span) instead of checking that the span was created.

Also note that because start has been moved to the SDK, there's no way to tell that a span has been started if it's an API object mock.

Oberon00 · 2019-11-25T10:28:02Z

@c24t about the test issues: I think we should switch all ext tests to use the SDK and the in-memory exporter instead of unittest.mock. That way the tests should be both easier to write & understand and test something that is closer to reality.

I created #303 to track this, I think we should do this in a separate PR, and I still think this one is fine.

Alex Boten added 2 commits November 14, 2019 11:05

removing create_span from the api

780c0ca

Signed-off-by: Alex Boten <[email protected]>

fix documentation

4774f2d

Signed-off-by: Alex Boten <[email protected]>

codeboten requested review from a-feld, c24t, carlosalberto, lzchen, Oberon00, reyang and toumorokoshi as code owners November 14, 2019 19:15

fixing docs

9c80a83

Signed-off-by: Alex Boten <[email protected]>

codeboten mentioned this pull request Nov 14, 2019

Add Flask integration based on WSGI ext #206

Merged

Oberon00 reviewed Nov 15, 2019

View reviewed changes

Alex Boten added 4 commits November 19, 2019 08:24

Merge remote-tracking branch 'origin/master' into remove-create-span

479e2ff

Add start_time parameter to start_span

87a4b97

This preserves the ability to set the `start_time` of a span that is currently available through calling `.start` Signed-off-by: Alex Boten <[email protected]>

Remove create_span from the sdk

f95d597

Signed-off-by: Alex Boten <[email protected]>

rename test

e38f5d6

Signed-off-by: Alex Boten <[email protected]>

codeboten commented Nov 19, 2019

View reviewed changes

Oberon00 approved these changes Nov 20, 2019

View reviewed changes

carlosalberto approved these changes Nov 22, 2019

View reviewed changes

Merge branch 'master' into remove-create-span

36d3afb

c24t approved these changes Nov 23, 2019

View reviewed changes

Update tests for missing create_span

371fa89

Oberon00 mentioned this pull request Nov 25, 2019

Switch unit tests from unittest.mock to SDK & in-memory exporter #303

Closed

Oberon00 added the PR:please merge This PR is ready to be merged by a Maintainer (has enough valid approvals, successful build, etc.) label Nov 25, 2019

c24t merged commit 033bcdc into open-telemetry:master Nov 25, 2019

c24t removed the PR:please merge This PR is ready to be merged by a Maintainer (has enough valid approvals, successful build, etc.) label Dec 11, 2019

codeboten deleted the remove-create-span branch October 9, 2020 18:50

srikanthccv pushed a commit to srikanthccv/opentelemetry-python that referenced this pull request Nov 1, 2020

chore: update out-of-date dependencies (open-telemetry#290)

498ab35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removing create_span from the api #290

Removing create_span from the api #290

codeboten commented Nov 14, 2019

codecov-io commented Nov 14, 2019 •

edited

Loading

Oberon00 commented Nov 15, 2019

Oberon00 Nov 15, 2019

Oberon00 commented Nov 15, 2019

codeboten Nov 19, 2019

Oberon00 Nov 20, 2019

Oberon00 commented Nov 22, 2019

c24t left a comment

c24t commented Nov 23, 2019

Oberon00 commented Nov 25, 2019 •

edited

Loading

		Applications that need to create spans detached from the tracer's
		context should use this method.

Removing create_span from the api #290

Removing create_span from the api #290

Conversation

codeboten commented Nov 14, 2019

codecov-io commented Nov 14, 2019 • edited Loading

Codecov Report

Oberon00 commented Nov 15, 2019

Oberon00 Nov 15, 2019

Choose a reason for hiding this comment

Oberon00 commented Nov 15, 2019

codeboten Nov 19, 2019

Choose a reason for hiding this comment

Oberon00 Nov 20, 2019

Choose a reason for hiding this comment

Oberon00 commented Nov 22, 2019

c24t left a comment

Choose a reason for hiding this comment

c24t commented Nov 23, 2019

Oberon00 commented Nov 25, 2019 • edited Loading

codecov-io commented Nov 14, 2019 •

edited

Loading

Oberon00 commented Nov 25, 2019 •

edited

Loading